/*
 * Copyright 2013 Glassy Cinema.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package hu.glassy.model.common;

import java.util.Date;
import javax.persistence.Column;
import javax.persistence.MappedSuperclass;
import javax.persistence.PrePersist;
import org.springframework.data.domain.Sort;

/**
 * The parent class of every entity which as a priority or a sort order.
 *
 * @author Alexander Molnár <molnar.alexander@sonrisa.hu>
 */
@MappedSuperclass
public abstract class SortableAbstractEntity extends AbstractEntity
{

  public static final Sort SORT_BY_PRIORITY_DESC = new Sort(Sort.Direction.ASC, "priority");

  @Column(name = "priority", nullable = false, unique = false)
  private Long priority;

  /**
   * @return the priority
   */
  public Long getPriority()
  {
    return priority;
  }

  /**
   * @param priority the priority to set
   */
  public void setPriority(Long priority)
  {
    this.priority = priority;
  }

  /**
   * Set the priority if it was not set.
   */
  @PrePersist
  protected void prePersist()
  {
    if (priority == null)
    {
      // By default the newest item will have the highest priority
      Date date = new Date();
      priority = date.getTime();
    }
  }

}
